Get Envelope
AutomatR.DocuSign.Activities.GetEnvelope
The "Get Envelope" activity in AutomatR is part of the DocuSign Envelope activities package, providing the ability to retrieve the status and information of a specific DocuSign envelope. This activity streamlines the process of obtaining envelope details for further analysis and decision-making within automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Envelope ID | Enter the Envelope ID for which you want to retrieve information. This field supports only Strings or String variables. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Get Envelope" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Output | |
| Response | Returns the envelope information in the form of an Envelope object. Variables of data type Envelope to store the envelope details. |
How to use:
- Drag and drop the "Get Envelope" activity onto the workflow.
- Configure the properties by specifying the Envelope ID and optionally, the Delay.
- Execute the workflow to retrieve information about the specified envelope.
Important Note:
- Ensure that the "Get Envelope" activity is used within the scope of the "DocuSign Scope" activity.
Example: Consider an example where the "Get Envelope" activity is used to retrieve information about an envelope with ID "env123":
Get Envelope:
Delay: 5
Envelope ID: "env123"
Response: envelopeInfo
In this example, the activity waits for 5 seconds (as specified in the Delay property) and then retrieves information about the envelope with ID "env123." The details of the envelope are stored in the variable "envelopeInfo" for further processing in the workflow.